scripty2

class S2.FX.Operators.Base

Description

This is a skeleton base class which must be extended to be useful.

Subclasses

S2.FX.Operators.Style, S2.FX.Operators.Scroll, S2.FX.Operators.CssTransition

Methods

Constructor

new S2.FX.Operators.Base(effect, object[, options])
  • effect (S2.FX.Effect) – The effect which uses this operator
  • object (Object) – A releatd object (mostly elements)
  • options (Object) – Additional options for the operator.

This is a skeleton base class which must be extended to be useful.

Options: * transition: a S2.FX.Transition method, defaults to a linear transition

Instance methods

  • applyValue #

    S2.FX.Operators.Base#applyValue(value) -> undefined
    • value (Object) – value to be rendered

    Needs to be overridden by subclasses.

  • inspect #

    S2.FX.Operators.Base#inspect() -> String

    Returns the debug-oriented string representation of an S2.FX.Operator.

  • render #

    S2.FX.Operators.Base#render() -> undefined

    Renders the Operator. This method is called by S2.FX.Element#animate.

  • setup #

    S2.FX.Operators.Base#setup() -> undefined

    Called when the operator is intialized. Intended to be overridden by subclasses.

  • valueAt #

    S2.FX.Operators.Base#valueAt(position) -> Object
    • position (Number) – position between 0 (start of operator) and 1 (end of operator)

    Returns the value for a specific position. Needs to be overridden by subclasses.